package com.bdqn.t350.vue.common.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                //apiInfo swagger的描述信息
                .apiInfo(apiInfo())
                .select()
                //扫描路径
                .apis(RequestHandlerSelectors.basePackage("com.bdqn.t350.vue.controller"))
                //路径匹配
                .paths(PathSelectors.any())
                .build().groupName("默认分组,需要验证token")
                //globalOperationParameters可以用于在全局范围内设置操作参数。这意味着，
                //可以将某些参数应用于所有的 API 操作中，而不必在每个操作中都重复定义它们。
                .globalOperationParameters(setHeaderToken());
    }


    /**
     * 公共接口,无需token验证
     * PathSelectors 可使用的 mapperHandler 路径匹配的方法：扫描匹配成功的路径，生成API
     * any() --- 匹配所有的路径
     * ant() --- 匹配传入参数的路径
     * regex() --- 通过正则表达式匹配路径
     */
    @Bean
    public Docket publicApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.bdqn.t350.vue.controller"))
                .paths(PathSelectors.ant("/login"))
                .build().groupName("无需token验证");
    }


    /**
     * 创建该Api的基本信息（这些基本信息会展现在文档页面中）
     *
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("T350项目")
                .description("项目实战")
                .termsOfServiceUrl("http://www.yuanxiaoxiang.com")
                .contact("14395202@qq.com")
                .version("1.0")
                .build();
    }


    /**
     * @param
     * @Description: 设置swagger文档中全局参数
     * @Date: 2020/9/11 10:15
     * @return: java.util.List<springfox.documentation.service.Parameter>
     */
    private List<Parameter> setHeaderToken() {
        List<Parameter> pars = new ArrayList<>();
        ParameterBuilder userId = new ParameterBuilder();
        userId.name("token").description("用户TOKEN").modelRef(new ModelRef("string")).parameterType("header")
                .required(true).build();
        pars.add(userId.build());
        return pars;
    }
}